Platform Explorer / Nuxeo Platform 2021.50

Operation Render.DocumentFeed (Render Document Feed)

Description

Get a list of documents as input and outputs a single blob containing the rendering of the document list. The template attribute may contain either the template content either a template URI. Template URis are strings in the form 'template:template_name' and will be located using the runtime resource service. Return the rendered blob
Operation id Render.DocumentFeed
Category Conversion
Label Render Document Feed
Requires
Since

Parameters

Name Description Type Required Default value
template string yes  
charset string no  
filename string no output.ftl 
mimetype string no text/xml 
type string no ftl, mvel 

Signature

Inputs documents
Outputs blob

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.rendering.operations.RenderDocumentFeed
Contributing Component org.nuxeo.ecm.core.automation.coreContrib

JSON Definition

{
  "id" : "Render.DocumentFeed",
  "label" : "Render Document Feed",
  "category" : "Conversion",
  "requires" : null,
  "description" : "Get a list of documents as input and outputs a single blob containing the rendering of the document list. The template attribute may contain either the template content either a template URI. Template URis are strings in the form 'template:template_name' and will be located using the runtime resource service. Return the rendered blob",
  "url" : "Render.DocumentFeed",
  "signature" : [ "documents", "blob" ],
  "params" : [ {
    "name" : "template",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : "TemplateResource",
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "charset",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "filename",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "output.ftl" ]
  }, {
    "name" : "mimetype",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "text/xml" ]
  }, {
    "name" : "type",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "ftl", "mvel" ]
  } ]
}